-
Notifications
You must be signed in to change notification settings - Fork 2.6k
Fixes dummy agent path in template docs #3698
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for submitting the FIX!!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Greptile Overview
Greptile Summary
This PR corrects documentation paths for dummy agent scripts in the template documentation (template.rst). Isaac Lab supports two project structures: external projects (standalone) and internal tasks (in-repository). External projects store dummy agent scripts at scripts/zero_agent.py and scripts/random_agent.py, while internal tasks organize them under scripts/environments/. The PR adds missing documentation for dummy agents in the External project section and fixes the Internal task paths to include the /environments/ subdirectory, aligning the documentation with the actual file structure of both template types.
Important Files Changed
| Filename | Score | Overview |
|---|---|---|
| docs/source/overview/own-project/template.rst | 5/5 | Adds dummy agent documentation for external projects and corrects internal task dummy agent paths from scripts/ to scripts/environments/ |
Confidence score: 5/5
- This PR is safe to merge with minimal risk as it only updates documentation strings with correct file paths
- Score reflects that this is a documentation-only change with no code logic modifications, clear intent, and proper path corrections verified against the repository structure
- No files require special attention; the changes are straightforward path corrections in RST documentation
Sequence Diagram
sequenceDiagram
participant User
participant "Documentation Reader" as Reader
participant "External Project" as ExtProj
participant "Template Generator" as TempGen
User->>Reader: "Read template documentation"
Reader->>Reader: "See incorrect dummy agent paths"
User->>TempGen: "Run ./isaaclab.sh --new"
TempGen->>ExtProj: "Generate external project"
User->>ExtProj: "python scripts/zero_agent.py --task=<Task-Name>"
Note over User,ExtProj: Previously incorrect path shown in docs
User->>ExtProj: "python scripts/random_agent.py --task=<Task-Name>"
Note over User,ExtProj: Now correctly documented
1 file reviewed, no comments
Description
Fixes incorrect dummy agent paths in the template docs and adds dummy agent instructions to the External Project section.
Type of change
Checklist
pre-commitchecks with./isaaclab.sh --formatconfig/extension.tomlfileCONTRIBUTORS.mdor my name already exists there